<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JSetField.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.annotation;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.ElementType;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.Retention;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.RetentionPolicy;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.Target;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * Java annotation for the getter methods of Java bean properties reflecting {@link org.jsimpledb.JSimpleDB}<a name="line.17"></a>
<span class="sourceLineNo">018</span> * {@link java.util.Set} fields.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * The annotated method's return type must be either {@link java.util.Set Set}{@code &lt;E&gt;},<a name="line.21"></a>
<span class="sourceLineNo">022</span> * {@link java.util.SortedSet SortedSet}{@code &lt;E&gt;}, or {@link java.util.NavigableSet NavigableSet}{@code &lt;E&gt;},<a name="line.22"></a>
<span class="sourceLineNo">023</span> * where {@code E} is a supported simple type.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;/p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Note that both primitive types and their corresponding wrapper types are supported as elements. A set whose<a name="line.27"></a>
<span class="sourceLineNo">028</span> * elements have primitive type will throw an exception on an attempt to add a null value.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * To specify a primitive element type, specify the type name (e.g., {@code "int"})<a name="line.29"></a>
<span class="sourceLineNo">030</span> * as the {@link JField#type} in the {@link #element}.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;/p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.33"></a>
<span class="sourceLineNo">034</span>@Target(ElementType.METHOD)<a name="line.34"></a>
<span class="sourceLineNo">035</span>@Documented<a name="line.35"></a>
<span class="sourceLineNo">036</span>public @interface JSetField {<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    /**<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * The name of this field.<a name="line.39"></a>
<span class="sourceLineNo">040</span>     *<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * &lt;p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * If empty string (default value), the name is inferred from the name of the annotated Java bean getter method.<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * &lt;/p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @return the set field name<a name="line.45"></a>
<span class="sourceLineNo">046</span>     */<a name="line.46"></a>
<span class="sourceLineNo">047</span>    String name() default "";<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Storage ID for this field. Value should be positive and unique within the contained class.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * If zero, the configured {@link org.jsimpledb.StorageIdGenerator} will be consulted to auto-generate a value.<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @return the set field storage ID<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @see org.jsimpledb.StorageIdGenerator#generateFieldStorageId StorageIdGenerator.generateFieldStorageId()<a name="line.54"></a>
<span class="sourceLineNo">055</span>     */<a name="line.55"></a>
<span class="sourceLineNo">056</span>    int storageId() default 0;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * Storage ID and index setting for the field's elements. Note: the {@link JField#name name} property must be left unset.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     *<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @return the set element field<a name="line.61"></a>
<span class="sourceLineNo">062</span>     */<a name="line.62"></a>
<span class="sourceLineNo">063</span>    JField element() default @JField();<a name="line.63"></a>
<span class="sourceLineNo">064</span>}<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>




























































</pre>
</div>
</body>
</html>
